Get API key
GET {{baseUrl}}/api/v2/api_keys/:api_key_id?include=<string>
Get an API key.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
include | string | Comma separated list of resource paths for related resources to include in the response. Supported resource paths are created_by and modified_by . |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":{"attributes":{"created_at":"\u003cstring\u003e","key":"\u003cstring\u003e","last4":"\u003cstring\u003e","modified_at":"\u003cstring\u003e","name":"\u003cstring\u003e"},"id":"\u003cstring\u003e","relationships":{"created_by":{"data":{"id":"\u003cstring\u003e","type":"users"}},"modified_by":{"data":{"id":"\u003cstring\u003e","type":"users"}}},"type":"api_keys"},"included":[{"attributes":{"created_at":"\u003cdateTime\u003e","disabled":"\u003cboolean\u003e","email":"\u003cstring\u003e","handle":"\u003cstring\u003e","icon":"\u003cstring\u003e","modified_at":"\u003cdateTime\u003e","name":"\u003cstring\u003e","service_account":"\u003cboolean\u003e","status":"\u003cstring\u003e","title":"\u003cstring\u003e","verified":"\u003cboolean\u003e"},"id":"\u003cstring\u003e","relationships":{"org":{"data":{"id":"\u003cstring\u003e","type":"orgs"}},"other_orgs":{"data":[{"id":"\u003cstring\u003e","type":"orgs"},{"id":"\u003cstring\u003e","type":"orgs"}]},"other_users":{"data":[{"id":"\u003cstring\u003e","type":"users"},{"id":"\u003cstring\u003e","type":"users"}]},"roles":{"data":[{"id":"\u003cstring\u003e","type":"roles"},{"id":"\u003cstring\u003e","type":"roles"}]}},"type":"users"},{"attributes":{"created_at":"\u003cdateTime\u003e","disabled":"\u003cboolean\u003e","email":"\u003cstring\u003e","handle":"\u003cstring\u003e","icon":"\u003cstring\u003e","modified_at":"\u003cdateTime\u003e","name":"\u003cstring\u003e","service_account":"\u003cboolean\u003e","status":"\u003cstring\u003e","title":"\u003cstring\u003e","verified":"\u003cboolean\u003e"},"id":"\u003cstring\u003e","relationships":{"org":{"data":{"id":"\u003cstring\u003e","type":"orgs"}},"other_orgs":{"data":[{"id":"\u003cstring\u003e","type":"orgs"},{"id":"\u003cstring\u003e","type":"orgs"}]},"other_users":{"data":[{"id":"\u003cstring\u003e","type":"users"},{"id":"\u003cstring\u003e","type":"users"}]},"roles":{"data":[{"id":"\u003cstring\u003e","type":"roles"},{"id":"\u003cstring\u003e","type":"roles"}]}},"type":"users"}]}