Reading resources

Notation follows the APIs index.

Read many

• HTTP verb MUST be GET.
• API path SHOULD follow the pattern /api/v1/{resource plural}.

Example

GET /api/v1/users
Accept: application/json

{
  "data": [
    {
      "attributes": {
        "email": "[email protected]",
        "name": "Bob Smith"
      },
      "id": "62bed180-1f78-45d4-8a56-c996936a2947",
      "type": "user"
    },
    {
      "attributes": {
        "email": "[email protected]",
        "name": "Alice Jones"
      },
      "id": "cacba8c1-29fa-4018-8950-acd400ec76b7",
      "type": "user"
    }
  ]
}

Success responses

Upon success, APIs MUST return 200.

Status	Description	Response
200 OK	Request was successful.	The resources requested.

See also:

• Advanced queries
• Filtering
• Paging
• Sorting
• Sparse fieldsets

Each service declares exactly which fields can be queried, because every query it supports has to be indexed and authorized.

Read one

• HTTP verb MUST be GET.
• API path SHOULD follow the pattern /api/v1/{resource plural}/{id}.

Example

GET /api/v1/users/62bed180-1f78-45d4-8a56-c996936a2947
Accept: application/json

{
  "data": {
    "attributes": {
      "email": "[email protected]",
      "name": "Bob Smith"
    },
    "id": "62bed180-1f78-45d4-8a56-c996936a2947",
    "type": "user"
  }
}

Success responses

Upon success, APIs MUST return 200.

Status	Description	Response
200 OK	Request was successful.	The resource requested.