Assignments

Fetching a list of Assignments

For Account Administrators, returns task assignments in all projects across an account. For non-Account Administrators, returns task assignments only in projects they are part of.

This endpoint returns structured Assignment objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the assignments top-level JSON key. Please see our Response Format section for more information.

get/assignments

Request

  • Base URL
    https://api.mavenlink.com/api/v1
  • Auth
    none declared

Query parameters

assignee_idinteger

Only includes assignments that belong to the specified user ID.

created_afterstring date-time

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_beforestring date-time

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

currentboolean

Only includes assignments that are active.

external_reference_external_messagestring

Filter the objects based on the external message of their associated external references. This is an exact match.

external_reference_external_statusstring

Filter by the status of the external object in the external system.

external_reference_service_modelstring

Filter by the type of the external object this external reference belongs to.

external_reference_service_model_refinteger

Filter by the id of the external object this external reference belongs to.

external_reference_service_model_refsstring

Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs.

external_reference_service_namestring

Filter by the name of the provider for integration.

external_reference_statusstring

Filter by the status of the integration, this can be successful or fail.

has_external_referencesboolean

Filter by whether or not the object has external references.

in_unarchived_storiesboolean

Only includes assignments that belong to inactive tasks. (Inactive tasks can exist in active projects, and vice versa.).

in_unarchived_workspacesboolean

Only includes assignments that belong to active projects.

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • assignee (User) - Retrieves the user assigned to the task. The response will include assignee_id, which references the data in the users top-level key.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • story (Story) - Retrieves the task. The response will include story_id, which references the data in the stories top-level key.
  • story_allocation_days (StoryAllocationDay) - Retrieves the Story Allocation Days (i.e. Daily Scheduled Hours) for the resource assigned to the task. When using this value, the plannable filter must be set to true. To retrieve story allocation days for unnamed resources, also set the include_unnamed filter to true. The response will include story_allocation_day_ids, which references the data in the story_allocation_days top-level key.
include_unnamedboolean

Includes task assignments to unnamed resources. Think of unnamed resources as placeholders; it indicates the need for a certain role, before knowing who will fill it. Set to False by default.

onlystring

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

orderstring

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: created_at:asc, created_at:desc, updated_at:asc, and updated_at:desc.

pageinteger
per_pageinteger
plannableboolean

Filters for assignments which the requester can view and create Daily Scheduled Hours for. Must be set to true when using the include parameter with the story_allocation_days association.

resource_idinteger

Only includes assignments that belong to the specified resource ID.

story_idinteger

Only includes assignments that belong to the specified task ID.

uncurrentboolean

Only includes assignments that are inactive.

updated_afterstring date-time

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_beforestring date-time

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

without_external_reference_service_namestring

Exclude by the existence of an external reference with the specified service name.

workspace_idinteger

Only includes assignments that belong to the specified project ID.

Response

A list of Assignments have been retrieved.

countinteger
assignmentsobject
external_referencesobject
storiesobject
usersobject
story_allocation_daysobject

Changes

No recorded changes to this operation across all 1 revision of this API.