Organisations

Get all

Endpoint

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

parameters

N/A

Response

{
    "data": [
        {
            "id": "...",
            "name": "...",
            "website": "...",
            "visible_to_client": "...",
            "keywords": "...",
            "teams": "...",
            "websites": "...",
            "competitors": "...",
            "is_favourite": "..."
        }
    ]
}

Get singular

Endpoint

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

Parameters

N/A

Response

{
    "data": {
        "id": "...",
        "name": "...",
        "website": "...",
        "visible_to_client": "...",
        "keywords": "...",
        "teams": "...",
        "websites": "...",
        "competitors": "...",
        "is_favourite": "..."
    }
}

Create

Endpoint

POST https://art.ayima.com/api/organisations

parameters

name	type	description	required
name	String	The name for the organisation you would like to create.	✅
website	String	The website address that is based associated with the organisation. 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 organisation should be visible to clients.	✅

Response

{
    "created": true,
    "uuid": "..."
}

Update

Endpoint

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

parameters

name	type	description	required
name	String	The name for the organisation you would like to create.	✅
website	String	The website address that is based associated with the organisation. 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 organisation should be visible to clients.	✅

Response

{
    "updated": true
}