Documentation

10. Team List API Endpoint

Make a GET request to this resource to retrieve the list of teams.

GET /api/v1/teams/
HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, POST, HEAD, OPTIONS
X-API-Time: 0.046s

The resulting data structure contains:

{
    "count": 0,
    "next": null,
    "previous": null,
    "results": []
}

The count field indicates the total number of teams found for the given query. The next and previous fields provides links to additional results if there are more than will fit on a single page. The results list contains zero or more team records.

10.1. Results

Each team data structure includes the following fields:

  • id: Database ID for this team. (integer)
  • type: Data type for this team. (multiple choice)
  • team: Team
  • url: URL for this team. (string)
  • related: Data structure with URLs of related resources. (object)
  • summary_fields: Data structure with name/description for related resources. (object)
  • created: Timestamp when this team was created. (datetime)
  • modified: Timestamp when this team was last modified. (datetime)
  • name: (string)
  • description: (string)
  • organization: (field)

10.2. Create Teams

Make a POST request to this resource with the following team fields to create a new team:

  • name: (string, required)
  • description: (string, default=””)
  • organization: (field, default=None)

10.3. Reviewing the Options Endpoint

The Options Endpoint table offers a view of the Options for this endpoint. When viewing the endpoint in the browsable API, clicking the “Options” button gives you the raw JSON for the following:

name Team List
description # List Teams: Make a GET request to this resource to retrieve the list of teams.
renders
0 application/json
1 text/html
parses
0 application/json
added_in_version 1.2
actions
POST
name
type string
required
true
label name
max_length 512
description
type string
required
false
label description
default (Empty Text)
organization
type field
required
false
default null
GET
id
type integer
label ID
help_text Database ID for this team.
type
type multiple choice
help_text Data type for this team.
choices
0
0 team
1 Team
url
type string
help_text URL for this team.
related
type object
help_text Data structure with URLs of related resources.
summary_fields
type object
help_text Data structure with name/description for related resources.
created
type datetime
help_text Timestamp when this team was created.
modified
type datetime
help_text Timestamp when this team was last modified.
name
type string
label name
description
type string
label description
organization
type field
types
0 team
search_fields
0 description
1 name