JOjobadder
Folder API:Folders

Find folders

Changed on
get/folders

Request

  • Base URL
    https://api.jobadder.com/v2
  • URL
    https://api.jobadder.com/v2/folders
  • Auth
    OAuth 2
    Authorization code: https://id.jobadder.com/connect/authorize
    Token URL: https://id.jobadder.com/connect/token scopes: read, read_folder

Query parameters

FolderIdinteger[]

Folder Id

JobIdinteger[]

Job Id

CandidateIdinteger[]

Candidate Id

ApplicationIdinteger[]

Job Application Id

PlacementIdinteger[]

Placement Id

CompanyIdinteger[]

Company Id

ContactIdinteger[]

Contact Id

UserIdinteger[]

User Id - search for folders by owner or shared with the specified users

OwnerUserIdinteger[]

User Id - search for folders by owner

SharedWithUserIdinteger[]

User Id - search folders shared with the specified users

OwnerStatus'Active' | 'Inactive' string

Owner status

CreatedAtstring[]

Search for folders created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

UpdatedAtstring[]

Search for folders updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

Fieldsstring[]

Additional fields to include with the results. Fields available to include are: sharedWith

Embedstring[]

Embed related resources.<br /> Resources available to embed are: self, jobs, candidates, applications, contacts, companies, placements

EmbedModestring

Determines what gets returned when embed option is one of self or candidates/contacts/etc.<br /> Resources available to embedMode are: id

Offsetinteger

The index of the first entry to return from the resource collection

Limitinteger

The maximum number of entries to return.<br /> Setting to 0 will return only the total count of matching resources.

Response

List of folders matching the specified criteria

totalCountinteger required

Changes