Fetches all project scopes

get

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

team_id

number

required

Team ID

Query Params

activity_phase_ids[]

array of numbers

Activity Phase IDs to filter by

activity_phase_ids[]

all

number

Disable Pagination

exclude_non_requests

boolean

Only considers scopes that are requested to be created or to be updates

group_determinant

string

One of created_at, requested_to_id, assignee_id, or activity_phase_id

include_requests

boolean

Considers all scopes, including those with either creation or update request

limit

number

Limit for Pagination

member_ids[]

array of numbers

Member IDs to filter by

member_ids[]

offset

number

Offset for Pagination

phase_ids[]

array of numbers

Phase IDs to filter by

phase_ids[]

project_ids[]

array of numbers

Project IDs to filter by

project_ids[]

schedule_end

date

End Date (MM/DD/YYYY)

schedule_start

date

Start Date (MM/DD/YYYY)

scope_ids[]

array of numbers

Scope IDs to filter by

scope_ids[]

sort_attributes[]

array of strings

An array of objects {direction:--, attribute:--}. Direction is either 'asc' or 'desc'. Attribute is one of requested_at, requested_to, requested_by, assignee_id, description, project, phase, or activity_phase_id

sort_attributes[]

Responses

200

Success

Example Response

mosaic_id is Scope ID in this case


{
  scopes:[
    assignees:[{
      id: 3333444,
    }],
    assigners:[{
      id: 8833300,
    }],
    created_at: "2023-02-16T14:51:50.497-05:00",
    description: "Scope Name",
    estimated_hours: 10,
    is_approved: true,
    is_requested: false,
    mosaic_id: 111222,
    mosaic_team_id: 12345,
    note: "scope notes",
    phase_id: 222
    portfolio_id: 1122,
    primary_assignee_id: 3333444,
    primary_assigner_id: 8833300,
    project_id: 12233,
    schedule_end: "2022-11-17",
    schedule_start: "2022-11-07",
    standard_work_category_id: 123333
    updated_at: "2023-04-26T12:56:56.117-04:00",
  ]
}

401

Invalid Authentication Key and/or Team ID