Skip to content

Get Profile API

The Get Profile API retrieves a single profile by its Profile ID. Use it when you need to inspect one profile's name, description, integrationCount for active integrations, and its createdAt and updatedAt timestamps before deciding what to do next.

Endpoint and purpose

The Get Profile API retrieves a single profile, including the count of active integrations bound to it. The endpoint uses the GET method with the Profile ID placed in the path. Keep the path exactly as /v1/profiles/{id} and supply the origin separately through the base URL placeholder in the request example.

Path parameters and input contract

The input contract is explicit and narrow: one required path parameter, id, typed as a string and described as the Profile ID. No optional parameters are part of this captured contract. Before sending the request, confirm that the value you place in the path is the identifier for the profile you intend to retrieve, because the response is scoped to that single profile.

Worked request example

The worked request example uses the captured identifier example 65ab123 in the path and sends the x-access-key header shown in this example. Replace the placeholder key value with your own credential when you use the example in a real client. After sending the request, check the status code first, then read the profile object from the response body rather than assuming the request succeeded.

Response field map

A successful response contains a success flag and a profile object. The profile object carries its own id, name, and description, plus integrationCount, which reports the count of active integrations bound to the profile. It also carries createdAt and updatedAt timestamps, which let you see when the profile was created and when it was last updated without making a second request.

Status codes and failure matrix

Treat the status codes as distinct checks in your client. A 200 response means Success and the profile object can be used. A 400 response means Invalid profile id, so review the identifier you sent. A 404 response means Profile not found, so the identifier may be well-formed but does not match an existing profile. Handling those two failures separately will make debugging faster than treating every non-200 response the same way.

Path parameters
ParameterTypeRequiredDescription
idstringYesProfile ID

Captured input contract for this endpoint; no optional parameters are included.

Response fields
FieldTypeDescription
successbooleanIndicates whether the request succeeded
profile.idstringProfile ID
profile.namestringProfile name
profile.descriptionstringProfile description
profile.integrationCountnumberCount of active integrations bound to the profile
profile.createdAtstringTimestamp when the profile was created
profile.updatedAtstringTimestamp when the profile was last updated

Field types for nested profile values are shown as captured in the example response; string and numeric examples are preserved as returned.

Status codes and failure matrix
Status codeMeaningWhat to check
200SuccessRead the profile object in the response body
400Invalid profile idReview the Profile ID supplied in the path
404Profile not foundConfirm the Profile ID matches an existing profile

Status meanings are limited to the captured meanings for this endpoint.

Frequently asked questions

What do I need to retrieve a single profile with the Get Profile API?

Send a GET request to /v1/profiles/{id} with the Profile ID in the path and the x-access-key header shown in the request example. A successful response returns success set to true and a profile object containing id, name, description, integrationCount, createdAt, and updatedAt.

How should I distinguish a 400 from a 404 when retrieving a profile?

Check the Profile ID first. A 400 response means Invalid profile id, while a 404 response means Profile not found. Those are different failure cases: one indicates the supplied identifier is invalid, and the other indicates no matching profile was found.

Where is the count of active integrations returned?

Use integrationCount in the profile object. It represents the count of active integrations bound to that profile, so it can be checked alongside the profile name, description, createdAt, and updatedAt values returned in the same response.

Get Profile API request example
curl "{{API_BASE_URL}}/v1/profiles/65ab123" \
  -H "x-access-key: YOUR_API_KEY"
Get Profile API response example
{
	"success": true,
	"profile": {
		"id": "65ab...",
		"name": "Acme Co",
		"description": "Example post details.",
		"integrationCount": 3,
		"createdAt": "2026-05-03T08:33:36.445Z",
		"updatedAt": "2026-05-03T08:33:36.445Z"
	}
}
Contract example 1
GET {{API_BASE_URL}}/v1/profiles/{id}