Journey Docs
Partner API ExplorerAccess

Get a user’s reach

Required scopepartner:access:read
GET
/v1/partner/users/{workosUserId}/scope

The brands and venues this user may act on within your organization.

Authorization

headerAuthorizationBearer <token>

WorkOS access token (JWT) for a user who is a member of the partner organization. The organization the request is scoped to is taken from the token, not from a header or query parameter.

Only a JWT is accepted in this header. A Journey jny_ API key sent as a bearer token is rejected with 401 Invalid or expired token; send it in X-API-Key instead.

WorkOS organization API keys are not accepted yet.

Path Parameters

workosUserId*string

WorkOS user id of the member of your organization.

Query Parameters

organizationId*string

Response Body

The user’s current reach.

curl -X GET 'https://api-prd.cf.journey.com/v1/partner/users/string/scope?organizationId=string'
Empty

WebhooksPREVIEW

Outbound webhooks for partner integrations — planned, not available today

Set a user’s reach

Next Page