Team Members

The Team Members API allows you to manage your team within your Rebill account. You can retrieve, update and remove members.


GET/v2/organizations/members

Get members

An organization account can be managed by different members, each with different permissions to access specific functions. This provides a more secure environment for teams to work in.

Loading...

Response

      [
        {
          "id": "43afb1d2-9292-419b-8434-ad67f4254852",
          "email": "john.doe@gmail.com",
          "enabled": true,
          "roles": [
            {
              "id": "b2fefb2b-1203-4322-a411-b835f29e9f26",
              "name": "customer",
              "description": "Customer of organization",
              "organizationId": "Customer of organization",
              "permissions": [
                "CREATE_AN_ITEM"
              ],
              "createdAt": "2024-02-28T16:11:00.595Z"
            }
          ],
          "profile": {
            "id": "4ce3935c-39f6-4c0a-b568-1ae42bf4d7dd",
            "firstName": "John",
            "lastName": "Doe",
            "cellPhone": "54111122530654",
            "birthday": "13-01-1989",
            "taxIdType": "CUIT",
            "taxIdNumber": "20940000019",
            "personalIdType": "DNI",
            "personalIdNumber": "94000001",
            "address": {
              "street": "Riverside St.",
              "city": "New York City",
              "state": "FL",
              "country": "USA",
              "zipCode": "90210",
              "number": "102",
              "floor": "2",
              "apt": "B",
              "description": "Home / Office"
            },
            "createdAt": "2024-02-28T16:11:00.596Z",
            "avatar": "avatar url"
          }
        }
      ]

GET/v2/organizations/members/{id}

Get member by id

Get the details of a specific member, such as email, role, profile, and more by its ID.

Required Path Parameters

    idstringrequired

Loading...

Response

  {
          "id": "43afb1d2-9292-419b-8434-ad67f4254852",
          "email": "john.doe@gmail.com",
          "enabled": true,
          "roles": [
            {
              "id": "b2fefb2b-1203-4322-a411-b835f29e9f26",
              "name": "customer",
              "description": "Customer of organization",
              "organizationId": "Customer of organization",
              "permissions": [
                "CREATE_AN_ITEM"
              ],
              "createdAt": "2024-02-28T16:11:00.595Z"
            }
          ],
          "profile": {
            "id": "4ce3935c-39f6-4c0a-b568-1ae42bf4d7dd",
            "firstName": "John",
            "lastName": "Doe",
            "cellPhone": "54111122530654",
            "birthday": "13-01-1989",
            "taxIdType": "CUIT",
            "taxIdNumber": "20940000019",
            "personalIdType": "DNI",
            "personalIdNumber": "94000001",
            "address": {
              "street": "Riverside St.",
              "city": "New York City",
              "state": "FL",
              "country": "USA",
              "zipCode": "90210",
              "number": "102",
              "floor": "2",
              "apt": "B",
              "description": "Home / Office"
            },
            "createdAt": "2024-02-28T16:11:00.596Z",
            "avatar": "avatar url"
          }
        }

POST/v2/organizations/members

Invite new member

You can invite new members to your organization, assigning them roles with certain permissions. If the user does not exist, then it is created.

Required Body Parameters

    firstNamestringrequired
    lastNamestringrequired
    roleIdsarray of stringsrequired
    emailstringrequired

Optional Body Parameters

    autoGeneratePasswordboolean
    passwordstring

Loading...

Response

  {
    "id": "xxxxx-9292-419b-8434-ad67f4254852",
    "email": "john.doe@gmail.com",
    "enabled": true,
    "roles": [
      {
        "id": "xxxxxx-1203-4322-a411-b835f29e9f26",
        "name": "customer",
        "description": "Customer of organization",
        "organizationId": "Customer of organization",
        "permissions": [
          "CREATE_AN_ITEM"
        ],
        "createdAt": "2024-02-28T16:11:00.595Z"
      }
    ],
    "profile": {
      "id": "xxxxx-39f6-4c0a-b568-1ae42bf4d7dd",
      "firstName": "John",
      "lastName": "Doe",
      "cellPhone": "xxxxxxx",
      "birthday": "13-01-1989",
      "taxIdType": "CUIT",
      "taxIdNumber": "xxxxxxxxx",
      "personalIdType": "DNI",
      "personalIdNumber": "xxxxxxxxx",
      "address": {
        "street": "Riverside St.",
        "city": "New York City",
        "state": "FL",
        "country": "USA",
        "zipCode": "90210",
        "number": "102",
        "floor": "2",
        "apt": "B",
        "description": "Home / Office"
      },
      "createdAt": "2024-02-28T16:11:00.596Z",
      "avatar": "http://matrix:8080/neo.png"
    }
  }

PUT/v2/organizations/members/{id}

Update member role

Use this endpoint to update the role of your team members.

Required Path Parameters

    idstringrequired

Required Body Parameters

    roleIdsarray of stringsrequired

Loading...

Response

    {
    "id": "xxxxx-9292-419b-8434-ad67f4254852",
    "email": "john.doe@gmail.com",
    "enabled": true,
    "roles": [
      {
        "id": "xxxxxx-1203-4322-a411-b835f29e9f26",
        "name": "customer",
        "description": "Customer of organization",
        "organizationId": "Customer of organization",
        "permissions": [
          "CREATE_AN_ITEM"
        ],
        "createdAt": "2024-02-28T16:11:00.595Z"
      }
    ],
    "profile": {
      "id": "xxxxx-39f6-4c0a-b568-1ae42bf4d7dd",
      "firstName": "John",
      "lastName": "Doe",
      "cellPhone": "xxxxxxx",
      "birthday": "13-01-1989",
      "taxIdType": "CUIT",
      "taxIdNumber": "xxxxxxxxx",
      "personalIdType": "DNI",
      "personalIdNumber": "xxxxxxxxx",
      "address": {
        "street": "Riverside St.",
        "city": "New York City",
        "state": "FL",
        "country": "USA",
        "zipCode": "90210",
        "number": "102",
        "floor": "2",
        "apt": "B",
        "description": "Home / Office"
      },
      "createdAt": "2024-02-28T16:11:00.596Z",
      "avatar": "http://matrix:8080/neo.png"
    }
  }

DELETE/v2/organizations/members/{id}

Remove member from organization

Use this endpoint to remove members from your organization.

Required Path Parameters

    idstringrequired

Loading...

Response

    {
      
  }

Was this page helpful?