Admins

Admins Documentation

Admin [LIST]

Admin [LIST]

Request

Endpoint

GET /api/v2/organizations/605392c3-b57c-495f-8770-6c2d3d3300ef/admins
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": [
    {
      "id": "d43bcbfa-2bbd-4695-8a94-a53f6f7e21e0",
      "type": "organization_admins",
      "attributes": {
        "created_at": "2022-01-12T17:18:16Z",
        "first_name": "Tesha",
        "last_name": null,
        "updated_at": "2022-01-12T17:18:16Z",
        "updated_in_db_at": "2022-01-12T17:18:16Z"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "577d122c-e929-4fc6-b71d-2057432991d0",
            "type": "users"
          }
        }
      }
    },
    {
      "id": "6ab03d66-0924-4962-9dca-f8bfa11f040d",
      "type": "organization_admins",
      "attributes": {
        "created_at": "2022-01-12T17:18:16Z",
        "first_name": "Fredric",
        "last_name": null,
        "updated_at": "2022-01-12T17:18:16Z",
        "updated_in_db_at": "2022-01-12T17:18:16Z"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "85cc6792-2a37-41c0-b8cf-4bf908f0a257",
            "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/a787f12e-a1e3-464f-876a-169f986b495b/admins/98bed84e-72eb-4553-83a4-97137bacb081
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "98bed84e-72eb-4553-83a4-97137bacb081",
    "type": "organization_admins",
    "attributes": {
      "created_at": "2022-01-12T17:18:17Z",
      "first_name": "Cordie",
      "last_name": null,
      "updated_at": "2022-01-12T17:18:17Z",
      "updated_in_db_at": "2022-01-12T17:18:17Z"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "3d8fcc74-35f0-40e4-85f5-1c41b06b91b6",
          "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/e0b37bae-dfaa-4ef0-bc92-5d5de48b0e0f/admins/187b3f0a-8ea3-4c40-babe-97834f7caecb
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body