logo

Organizations

The organizations endpoint provides details about a business entity, such as an employer, or a group of people, such as a division.

The response includes the organization name and ID which can be used to make subsequent endpoint calls related to the organization and its employees.

Get an organization

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

Securityoauth_client_credentials_token
Request
path Parameters
organization_id
required
string

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000
header Parameters
DailyPay-API-Version
integer
Default: 3

The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used.

Example: 3
Accept
required
string

The media type of the requested payload. This should be set to application/vnd.api+json to signify your client can receive responses in the JSON:API format. For more details, see https://jsonapi.org.

Value: "application/vnd.api+json"
Responses
200

Returns details about an organization.

Response Schema: application/vnd.api+json
required
object (OrganizationResource)
type
required
string
Value: "organizations"
id
required
string <uuid> (OrganizationID)

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

required
object (OrganizationAttributes)
name
string

Organization's name

Example: "DailyPay"
products
Array of strings

List of the names of products available for this organization.

Items Enum Value Description
ODP

On-Demand Pay (ODP) is a DailyPay product that allows employees to access their earned wages before payday. An organization with this product enabled will have on-demand pay available to its members; an account with type EARNINGS_BALANCE will automatically be created for each job associated with this organization.

FRIDAY

An organization with this product enabled will have the Friday by DailyPay Visa®️ Prepaid Card program available to its members.

WISELY_EWA

An organization with this product enabled will have the Wisely® by ADP® card program available to its members.

Example: ["ODP","FRIDAY"]
required
object (OrganizationLinks)
self
required
string <uri> (OrganizationLink)
400

Bad Request

401

Invalid authentication credentials

403

Not authorized to perform this operation

404

Resource was not found

500

Unexpected error occured

get/rest/organizations/{organization_id}
Request samples 
Response samples 
application/vnd.api+json
{}
List organizations
Get organizations with an optional filter


Securityoauth_client_credentials_token 
Request 
query Parameters
filter
string
  Examples: 
filter=name:"DailyPay"
filter=name~"Daily"
header Parameters
DailyPay-API-Version
integer
 Default:  3
The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used.


 
 Example:  3
Accept
required
string
The media type of the requested payload. This should be set to application/vnd.api+json to signify your client can receive responses in the JSON:API format.  For more details, see https://jsonapi.org.


 
 Value:  "application/vnd.api+json"
Responses 
200
Returns a list of organization objects 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/vnd.api+json
required
Array of objects (OrganizationResource) 
 
 Array 
type
required
string
 
 Value:  "organizations"
id
required
string <uuid>  (OrganizationID) 
String identifier that is unique to this organization. You can safely assume the identifier to never exceed 64 characters.


 
required
object (OrganizationAttributes) 
 
required
object (OrganizationLinks) 
 
400
Bad Request


401
Invalid authentication credentials


403
Not authorized to perform this operation


500
Unexpected error occured


get/rest/organizations
Request samples 
Response samples 
application/vnd.api+json
{}
➔ Next to Paychecks