v1

latestOpenAPI 3.0.22026-07-24800528.1 KB
Applications

List Applications

Returns a cursor-paginated list of applications submitted to your company. Results are ordered by creation date descending by default. Use the starting_after or ending_before cursor parameters to page through results.

get/v2/applications

Query parameters

statusstring

Comma-separated list of statuses to filter by. Accepted values: pending, approved, declined, flagged. flagged matches applications from partnerships flagged for fraudulent activity and may be combined with other values (e.g. pending,flagged). Omit to return applications of all statuses.

emailstring

Filter by applicant email address (case-insensitive, substring match).

group_keystring[]

Group keys in which the results are filtered by

min_createdinteger

Applies a minimum epoch timestamp (ms) filter to the response created_at.

max_createdinteger

Applies a maximum epoch timestamp (ms) filter to the response created_at.

order_by'-created_at' | 'created_at'

Field to sort results by. A leading - denotes descending order. Defaults to -created_at.

limitinteger

A limit on the number of items to be returned. Limits can range between 1 and 250, and the default is 10.

starting_afterstring

A cursor for use in pagination, starting_after takes in an item key and the subsequent call will return the following items in the list. This is mutually exclusive with ending_before.

ending_beforestring

A cursor for use in pagination, ending_before takes in an item key and the subsequent call will return the prior items in the list. This is mutually exclusive with starting_after.

Response

Returns a cursor-paginated list of applications submitted to your company. Results are ordered by creation date descending by default. Use the starting_after or ending_before cursor parameters to page through results.

messagestring required
statusinteger required

Example response

{
  "data": {
    "items": [
      {
        "created_at": 1574181282399,
        "key": "co_a80cb515fe",
        "updated_at": 1574181282399,
        "actioned_by": "mem_1a2b3c4d5e",
        "content": {
          "field_1HTqIBy9j0y70d": "Acme Inc.",
          "field_72y2kTfdUb57AP": "Yes"
        },
        "decline_reason": "Not a good fit at this time.",
        "group_name": "Affiliate Program",
        "partnership_source": "page",
        "team_color": "#FF5733",
        "team_key": "stck_1a2b3c4d5e",
        "team_logo": "file_1a2b3c4d5e",
        "team_name": "Acme Partners",
        "with_profile": true
      }
    ]
  }
}