Skip to main content
GET
Get distribution request

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

id
string
required

Response

id
string
required

Unique identifier for the distribution request

Pattern: ^distribution_request(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
type
string
required

entity type

status
enum<string>
required

Status of the distribution request

Available options:
PENDING,
WAITING_FOR_SIGNATURE,
APPROVED,
DENIED,
REVOKED
brokerageFirmId
string
required

Brokerage firm the request is attached to

Pattern: ^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
productId
string
required

Product the request is for

createdAt
string<date-time>
required

Date the request was created