Fetches entity rates

get

http://localhost:3001/api/{team_id}/entity_rate

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

team_id

number

required

Team ID

Query Params

all

boolean

Return all entity rates in a team if set true; ignore limit and offset

end_date

string

Date in which the following entity rate finished being effective

entity_ids

array of numbers

IDs of the entity which the entity rate belongs to

entity_ids

entity_rate_ids

array of numbers

IDs of the entity rate

entity_rate_ids

entity_type

string

Type of the entity; either role (Position) or standard_work_category (Activity)

include_archived

boolean

Include the archived entity rates in the search

is_cost_rate

boolean

Return entity rates that are cost rates

limit

number

Limit the number of the entity rates being returned (default: 20)

offset

number

Skip the offset number of entity rates in the search (default: 0)

rate_group_ids

array of numbers

IDs of the rate group which the entity rate belongs to

rate_group_ids

rate_ids

array of numbers

IDs of the rate which the entity rate belongs to

rate_ids

start_date

string

Date in which the following entity rate became effective

Responses

200

Success

Example Response

mosaic_id is the Entity Rate ID in this case


{
  entity_rates: [
    {
        archived_at: null,
        created_at: "2023-03-13T19:43:08.380-04:00",
        end_date: "2023-03-12",
        entity_id: 9118,
        entity_type: "Activity",
        mosaic_id: 1234,
        is_cost_rate: false,
        rate_group_id: 13282,
        rate_id: null,
        start_date: "1900-01-01",
        mosaic_team_id: 12345,
        updated_at: "2023-03-13T19:47:29.510-04:00"
    },
  ]
}

401

Invalid Authentication Key and/or Team ID

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here!