Legal Entities

Prev Next
Get
/public/v1/core/legal-entities

Retrieves a list of legal entities for a tenant. At least one of modifiedOnStart or modifiedOnEnd must be provided

Security

The requesting user must have the following permission to retrieve legal entities:

  • Administration → Legal Entities → View Legal Entities
Security
HTTP
Type Bearer
Header parameters
x-r365-context-tenant-id
stringRequired

Identifies the R365 tenant the request applies to. Required on every request.

Query parameters
modifiedOnStart
string (date-time)

Start of the modified-on date range (inclusive). If only this value is provided, results for that single day are returned

modifiedOnEnd
string (date-time)

End of the modified-on date range (inclusive). If only this value is provided, results for that single day are returned

pageSize
integer (int32)

Maximum number of top-level objects to return in one page.

Minimum1.0
Maximum250.0
Default250
continuationToken
string

Continuation token returned by a previous response to retrieve the next page

Responses
200

Paginated list of legal entities

Expand All
object
legalEntities
Array of object (LegalEntity)

Legal entities matching the request criteria.

object
id
string (uuid)
name
string
number
string
isActive
boolean
taxId
string
stateId
string
payrollProviderId
string
address1
string
address2
string
city
string
state
string
zipCode
string
country
string
nextLink
string | null

Link to retrieve the next page of results. Null when no further pages exist.

400

Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.

401

Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.

403

Forbidden — the caller lacks the permission required for this operation.

404

Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.

409

Conflict — the request conflicts with the current state of the resource and cannot be applied.

422

Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.

429

Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.

500

Internal Server Error — an unexpected error occurred while processing the request.