Get Profile API — GET /v1/profiles/{id}
The Get Profile API retrieves a single profile by its Profile ID. It uses GET /v1/profiles/{id}, requires the x-access-key header, and returns application/json responses for success and for the documented 400 and 404 failures.
Get Profile API — GET {{API_BASE_URL}}/v1/profiles/{id}
Use GET with the unchanged path /v1/profiles/{id}. Replace only the origin with {{API_BASE_URL}} in samples, so the full request target is {{API_BASE_URL}}/v1/profiles/{id}. The method is GET and the path case must be preserved exactly.
Authorization: x-access-key header
Authorization uses the accessKey scheme named x-access-key. Send the header x-access-key with a <token> value on the request. No other authorization scheme is documented for this endpoint, and no authentication failure status is specified in the captured contract.
Path Parameters: id (required string, Profile ID)
The endpoint has one required path parameter, id, typed as string and described as Profile ID. Substitute the identifier into the {id} segment of /v1/profiles/{id}. No query parameters are documented for this endpoint.
Response Body 200: success and profile field map
A successful response uses 200 with application/json. The body contains success as a required boolean and profile as a required object. Parse profile fields according to the field map in the response table below, including the nullable description and the non-negative integer integrationCount.
Response Body 400 / 404: error shape and failure matrix
The documented failure responses are 400 application/json and 404 application/json. Both use the same shape, an object with a required error string field. A client should branch on the status code first, then read error as a string, without assuming specific messages beyond that shape.
Origin-modular request sample and contract notes
Build the request by setting the method to GET, constructing {{API_BASE_URL}}/v1/profiles/{id} with the Profile ID, and adding the x-access-key header. After the call, check the status code: on 200, read success and profile; on 400 or 404, read error. The request sample and response examples are provided once in the examples section under their human-readable titles.
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
| x-access-key | header | required | string (<token>) | Authorization header named accessKey in the source contract. |
| id | path | required | string | Profile ID |
Exact captured input contract for GET /v1/profiles/{id}.
| Field | Required | Type | Constraints / Notes |
|---|---|---|---|
| success | required | boolean | Top-level response field. |
| profile | required | object | Top-level response field containing the profile object. |
| profile.id | required | string | |
| profile.name | required | string | |
| profile.description | required | string | null | May be a string or null. |
| profile.integrationCount | required | integer | 0 <= value; number of active integrations bound to this profile. |
| profile.createdAt | required | string | date-time |
| profile.updatedAt | required | string | date-time |
Exact captured 200 response field map; description is string | null.
| Status | Content type | Body shape | Client handling |
|---|---|---|---|
| 400 | application/json | {"error": "string"} with error required string | Branch on 400, then read error as string. |
| 404 | application/json | {"error": "string"} with error required string | Branch on 404, then read error as string. |
Only 400 and 404 are documented for this endpoint; no other error semantics are specified.
Frequently asked questions
What is required to call the Get Profile API?
Send GET to /v1/profiles/{id} with the x-access-key header set to <token> and replace {id} with the required Profile ID string.
What fields are returned by the Get Profile API?
The 200 response contains success as a boolean and profile as an object with id, name, description, integrationCount, createdAt, and updatedAt. Both 400 and 404 responses use application/json with an error string field.
How should a client handle 400 and 404 responses from this endpoint?
Check that the path parameter is present and is the intended Profile ID, that the x-access-key header is included, and that the response status is 400 or 404 with an error string. Do not assume additional error codes or messages beyond the documented contract.
curl -X GET "{{API_BASE_URL}}/v1/profiles/{id}" -H "x-access-key: <token>"{
"success": true,
"profile": {
"id": "string",
"name": "string",
"description": "string",
"integrationCount": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}{
"error": "string"
}| Scope | Field | Type | Type reference | Required | Description | Constraints |
|---|---|---|---|---|---|---|
| id#1 | id | string | __0 | Yes | Profile ID | |
| response#2 | response | object | __0 | |||
| response#2 | response.success | boolean | __1 | Yes | ||
| response#2 | response.profile | object | __2 | Yes | ||
| response#2 | response.profile.id | string | __3 | Yes | ||
| response#2 | response.profile.name | string | __4 | Yes | ||
| response#2 | response.profile.description | string | null | __5 | Yes | ||
| response#2 | response.profile.description[variant1] | string | __5_type:string | |||
| response#2 | response.profile.description[variant2] | null | __5_type:null | |||
| response#2 | response.profile.integrationCount | integer | __6 | Yes | Number of active integrations bound to this profile | kind: ; value: 0 <= value |
| response#2 | response.profile.createdAt | string | __7 | Yes | kind: ; value: date-time | |
| response#2 | response.profile.updatedAt | string | __8 | Yes | kind: ; value: date-time | |
| response#3 | response | object | __0 | |||
| response#3 | response.error | string | __1 | Yes |