Admins

Admins Documentation

Admin [LIST]

Admin [LIST]

Request

Endpoint

GET /api/v2/organizations/7e7f893e-a5dc-419d-a5d8-84fbefeb9e64/admins
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "1d53a199-9394-4b7d-b587-e7fb0cc322e5",
      "type": "organization_admins",
      "attributes": {
        "created_at": "2021-11-23T14:37:56Z",
        "first_name": "Lewis",
        "last_name": null,
        "updated_at": "2021-11-23T14:37:56Z",
        "updated_in_db_at": "2021-11-23T14:37:56Z"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "dec8821a-530a-4fe2-a927-bf0f47d10474",
            "type": "users"
          }
        }
      }
    },
    {
      "id": "5cc3dad1-ca99-4b38-86b7-61267d04917d",
      "type": "organization_admins",
      "attributes": {
        "created_at": "2021-11-23T14:37:56Z",
        "first_name": "Val",
        "last_name": null,
        "updated_at": "2021-11-23T14:37:56Z",
        "updated_in_db_at": "2021-11-23T14:37:56Z"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "87ed0983-98f9-435b-a9e9-e1838970fd06",
            "type": "users"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 2,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [OrganizationAdmin]

Description An array of OrganizationAdmin Objects

Admin [GET]

Admin [GET]

Request

Endpoint

GET /api/v2/organizations/7e7241fd-ef98-495e-95a1-06bffb94262f/admins/09c4a798-7d42-4eb3-903f-3c41075952fb
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "09c4a798-7d42-4eb3-903f-3c41075952fb",
    "type": "organization_admins",
    "attributes": {
      "created_at": "2021-11-23T14:37:55Z",
      "first_name": "Julianne",
      "last_name": null,
      "updated_at": "2021-11-23T14:37:55Z",
      "updated_in_db_at": "2021-11-23T14:37:55Z"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "8a7914ba-b3e4-4787-b2ab-c0e16b3cbc9b",
          "type": "users"
        }
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

first_name

Type string

Description First Name

last_name

Type string

Description Last Name

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

user.data

Type Organization

Description The user that is an admin of the connected organization

Admin [DELETE]

Admin [DELETE]

Request

Endpoint

DELETE /api/v2/organizations/96d2bde0-2a46-4b88-aa6d-1aa24dfec1d0/admins/72e15160-8e71-4b94-a8e0-f367f60d87d2
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body