Organizations

Information about an employer

Get an organization

Lookup organization by ID for a detailed view of single organization.

SecurityclientBasicAuth
Request
path Parameters
organization_id
required
string (ResourceId)

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000
Responses
200

Returns details about an organization.

Response Schema: application/json
id
string

String identifier that is unique to this organization. You can safely assume the identifier to never exceed 64 characters.

Example: "f0b30634-108c-439c-a8c1-c6a91197f022"
name
string

Organization's name

Example: "DailyPay"
products
Array of strings

List of the names of products available for this organization.

Items Enum: "FRIDAY" "WISELY_EWA"
Example: ["FRIDAY","WISELY_EWA"]
self_link
string <uri>

The API location of this organization.

Example: "https://extend-api.dailypay.com/organizations/f0b30634-108c-439c-a8c1-c6a91197f022"
401

Client authorization is invalid.

403

Client requires additional permissions or scopes.

404

Requested resource could not be found.

500

Server experienced an unknown or unexpected error.

get/organizations/{organization_id}
Request samples
Response samples
application/json
{}

List organizations

Get organizations with an optional filter

SecurityclientBasicAuth
Request
query Parameters
filter
string
Example: filter=name:"DailyPay"
Responses
200

Returns a collection of organizations that match the filter. If no organizations match the filter, the resulting collection will be empty. If no filter is provider, the resulting collection will include all accessible organizations.

Response Schema: application/json
Array of objects (Organization)

An array of up to 25 organizations that matched the filter query

Array
id
string

String identifier that is unique to this organization. You can safely assume the identifier to never exceed 64 characters.

Example: "f0b30634-108c-439c-a8c1-c6a91197f022"
name
string

Organization's name

Example: "DailyPay"
products
Array of strings

List of the names of products available for this organization.

Items Enum: "FRIDAY" "WISELY_EWA"
Example: ["FRIDAY","WISELY_EWA"]
self_link
string <uri>

The API location of this organization.

Example: "https://extend-api.dailypay.com/organizations/f0b30634-108c-439c-a8c1-c6a91197f022"
400

Either input was invalid or user was not in necessary state

401

Client authorization is invalid.

403

Client requires additional permissions or scopes.

404

Requested resource could not be found.

500

Server experienced an unknown or unexpected error.

get/organizations
Request samples
Response samples
application/json
{}