Organisation Teams

Please note that teams are a direct child entity of an organisation. For majority for the teams API functions, you will need to retrieve the organisation ID before hand.

Get all

Endpoint

GET https://art.ayima.com/api/teams

parameters

N/A

Response

{
    "data": [
        {
            "id": "...",
            "name": "...",
            "website": "...",
            "keywords": "...",
            "visible_to_client": "...",
            "team_members": "...",
            "reports": "...",
            "websites": "...",
            "is_favourite": "...",
            "created_at": "..."
        }
    ]
}

Get organisation teams

Endpoint

GET https://art.ayima.com/api/organisations/{organisationId}/teams

Parameters

N/A

Response

{
    "data": [
        {
            "id": "...",
            "name": "...",
            "website": "...",
            "keywords": "...",
            "visible_to_client": "...",
            "team_members": "...",
            "reports": "...",
            "websites": "...",
            "is_favourite": "...",
            "created_at": "..."
        }
    ]
}

Get singular organisation team

Endpoint

GET https://art.ayima.com/api/organisations/{organisationId}/teams/{teamId}

Parameters

N/A

Response

{
    "data": {
        "id": "...",
        "name": "...",
        "website": "...",
        "keywords": "...",
        "visible_to_client": "...",
        "team_members": "...",
        "reports": "...",
        "websites": "...",
        "is_favourite": "...",
        "created_at": "..."
    }
}

Create

Endpoint

POST https://art.ayima.com/api/organisations/{organisationId}/teams

parameters

name	type	description	required
name	String	The name for the team you would like to create.	✅
website	String	The website address that is based associated with the team. Please note this is not used for report creation- simply used to get metadata such as logo for the organisation.	✅
visible_to_client	Boolean	Indication if the team should be visible to clients.	✅

Response

{
    "created": true
}

Update

PUT https://art.ayima.com/api/organisations/{organisationId}/teams/{teamId}

parameters

name	type	description	required
name	String	The name for the team you would like to create.	✅
website	String	The website address that is based associated with the team. Please note this is not used for report creation- simply used to get metadata such as logo for the organisation.	✅
visible_to_client	Boolean	Indication if the team should be visible to clients.	✅

Response

{
    "updated": true
}

Get Reports

GET https://art.ayima.com/api/organisations/{organisationId}/teams/{teamId}/reports

Parameters

N/A

Response

{
  "data": [
        {
            "id": "...",
            "secret": "...",
            "name": "...",
            "is_building": "...",
            "build_reason": "...",
            "build_percent": "...",
            "back_fill_from": "...",
            "original_name": "...",
            "gs_data_studio_enabled": "...",
            "gs_data_studio_secret": "...",
            "group_stats_as": "...",
            "visible_to_client": "...",
.....