Nested teams

Retrieve a list of nested team relations

GET

https://partner-api.monta.com

/api/v1/nested-teams

Required scope: team-members:read
Organization authorization: supported

Retrieve a list of nested team relations › query Parameters

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

state

string · enum

State of the nested team invitation

Enum values:

requested

invited

accepted

rejected_at

blocked

expired

Example: accepted

includeDeleted

boolean | null

Includes deleted resources in the response

Example: false

Default: false

nestedTeamIds

string | null

Filter by a comma-separated list of nested team ids

Example: 21,34

parentTeamIds

string | null

Filter by a comma-separated list of parent team ids

Example: 7,8

priceGroupIds

string | null

Filter by a comma-separated list of price group ids

Example: 5,6

invitedByUserIds

string | null

Filter by a comma-separated list of inviting user ids

Example: 101,102

access

string · enum

Filter by the team member's access level on the nested team relation

Enum values:

all

selected

Example: all

Retrieve a list of nested team relations › Responses

List of nested team relations that match the criteria

OffsetBasedResponse_33

NestedTeam[] · required

MontaPage.Meta · required

GET/api/v1/nested-teams

curl https://partner-api.monta.com/api/v1/nested-teams \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1,
      "parentTeam": {
        "id": 1,
        "publicName": "Example Team",
        "memberCount": 10
      },
      "nestedTeam": {
        "id": 1,
        "publicName": "Example Team",
        "memberCount": 10
      },
      "priceGroup": {
        "id": 1,
        "name": "Standard Pricing"
      },
      "invitedByUser": {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe",
        "displayName": "johndoe123"
      },
      "userRole": "user",
      "access": "all",
      "state": "accepted",
      "selectedChargePointIds": [
        41,
        72,
        93
      ],
      "note": "Internal note placeholder",
      "createdAt": "2022-07-27T18:11:41Z",
      "updatedAt": "2022-07-28T18:11:41Z",
      "invitedAt": "2022-07-28T18:11:41Z"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Nested team invite

POST

https://partner-api.monta.com

/api/v1/nested-teams/invite

Required scope: team-members:write
Organization authorization: supported

Nested team invite › Request Body

NestedTeamInvite

parentTeamId

integer · int64 · required

Id of the parent team, the one who sends the invite

Example: 1

nestedTeamId

integer · int64 · required

Id of the nested team, the one who receives the invite

Example: 2

priceGroupId

integer · int64 · required

Price group applied to the nested team

Example: 3

access

string · enum · required

Is access granted to all or selected charge points and sites

Enum values:

all

selected

Example: all

selectedChargePointIds

array | null

List of charge point ids nested team access will be assigned to

selectedSiteIds

array | null

List of site ids nested team access will be assigned to

Nested team invite › Responses

Nested team invite sent

NestedTeam

object · required

Parent team, the one who sends the invite

userRole

string · enum · required

The role assigned to the nested team

Enum values:

user

Example: user

access

string · enum · required

Access to parent team CPs / sites: to all or selected charge points and/or sites

Enum values:

all

selected

Example: all

state

string · enum · required

State of the nested team invitation

Enum values:

requested

invited

accepted

rejected_at

blocked

expired

Example: accepted

createdAt

string · date-time · required

Datetime of the creation of nested team invite

Example: 2022-07-27T18:11:41Z

id

integer · int64

Id of the nested team relation

Example: 1

object

Parent team, the one who receives the invite

object

Price group applied to the nested team

object

User who requested the invitation

selectedChargePointIds

array | null

Selected charge points nested team has access to

Example: [41,72,93]

note

string | null

Internal note for this nested team

Example: Internal note placeholder

updatedAt

string | null · date-time

Datetime of the update of nested team invite

Example: 2022-07-28T18:11:41Z

invitedAt

string | null · date-time

Datetime nested team was invited

Example: 2022-07-28T18:11:41Z

POST/api/v1/nested-teams/invite

curl https://partner-api.monta.com/api/v1/nested-teams/invite \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "parentTeamId": 1,
  "nestedTeamId": 2,
  "priceGroupId": 3,
  "access": "all",
  "selectedChargePointIds": [
    0
  ],
  "selectedSiteIds": [
    0
  ]
}'

Example Request Body

{
  "parentTeamId": 1,
  "nestedTeamId": 2,
  "priceGroupId": 3,
  "access": "all",
  "selectedChargePointIds": [
    0
  ],
  "selectedSiteIds": [
    0
  ]
}

json

Example Responses

{
  "id": 1,
  "parentTeam": {
    "id": 1,
    "publicName": "Example Team",
    "memberCount": 10
  },
  "nestedTeam": {
    "id": 1,
    "publicName": "Example Team",
    "memberCount": 10
  },
  "priceGroup": {
    "id": 1,
    "name": "Standard Pricing"
  },
  "invitedByUser": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "displayName": "johndoe123"
  },
  "userRole": "user",
  "access": "all",
  "state": "accepted",
  "selectedChargePointIds": [
    41,
    72,
    93
  ],
  "note": "Internal note placeholder",
  "createdAt": "2022-07-27T18:11:41Z",
  "updatedAt": "2022-07-28T18:11:41Z",
  "invitedAt": "2022-07-28T18:11:41Z"
}

json

application/json

Get a nested team by nested team relation id

GET

https://partner-api.monta.com

/api/v1/nested-teams/{relationId}

Required scope: team-members:read
Organization authorization: supported

Get a nested team by nested team relation id › path Parameters

relationId

integer · int64 · required

Get a nested team by nested team relation id › Responses

Nested team relation

NestedTeam

object · required

Parent team, the one who sends the invite

userRole

string · enum · required

The role assigned to the nested team

Enum values:

user

Example: user

access

string · enum · required

Access to parent team CPs / sites: to all or selected charge points and/or sites

Enum values:

all

selected

Example: all

state

string · enum · required

State of the nested team invitation

Enum values:

requested

invited

accepted

rejected_at

blocked

expired

Example: accepted

createdAt

string · date-time · required

Datetime of the creation of nested team invite

Example: 2022-07-27T18:11:41Z

id

integer · int64

Id of the nested team relation

Example: 1

object

Parent team, the one who receives the invite

object

Price group applied to the nested team

object

User who requested the invitation

selectedChargePointIds

array | null

Selected charge points nested team has access to

Example: [41,72,93]

note

string | null

Internal note for this nested team

Example: Internal note placeholder

updatedAt

string | null · date-time

Datetime of the update of nested team invite

Example: 2022-07-28T18:11:41Z

invitedAt

string | null · date-time

Datetime nested team was invited

Example: 2022-07-28T18:11:41Z

GET/api/v1/nested-teams/{relationId}

curl https://partner-api.monta.com/api/v1/nested-teams/:relationId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": 1,
  "parentTeam": {
    "id": 1,
    "publicName": "Example Team",
    "memberCount": 10
  },
  "nestedTeam": {
    "id": 1,
    "publicName": "Example Team",
    "memberCount": 10
  },
  "priceGroup": {
    "id": 1,
    "name": "Standard Pricing"
  },
  "invitedByUser": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "displayName": "johndoe123"
  },
  "userRole": "user",
  "access": "all",
  "state": "accepted",
  "selectedChargePointIds": [
    41,
    72,
    93
  ],
  "note": "Internal note placeholder",
  "createdAt": "2022-07-27T18:11:41Z",
  "updatedAt": "2022-07-28T18:11:41Z",
  "invitedAt": "2022-07-28T18:11:41Z"
}

json

application/json

Update a nested team relation

PATCH

https://partner-api.monta.com

/api/v1/nested-teams/{relationId}

Required scope: team-members:write
Organization authorization: supported

Update a nested team relation › path Parameters

relationId

integer · int64 · required

Update a nested team relation › Request Body

PatchNestedTeam

priceGroupId

integer | null · int64

Price group applied to the nested team

Example: 1

note

string | null · maxLength: 255

A note (instructions, warning, information) you have entered for this nested team member

Example: A note for nested team member

selectedChargePointIds

array | null

List of charge point ids nested team access will be assigned to

Update a nested team relation › Responses

Nested team invite sent

NestedTeam

object · required

Parent team, the one who sends the invite

userRole

string · enum · required

The role assigned to the nested team

Enum values:

user

Example: user

access

string · enum · required

Access to parent team CPs / sites: to all or selected charge points and/or sites

Enum values:

all

selected

Example: all

state

string · enum · required

State of the nested team invitation

Enum values:

requested

invited

accepted

rejected_at

blocked

expired

Example: accepted

createdAt

string · date-time · required

Datetime of the creation of nested team invite

Example: 2022-07-27T18:11:41Z

id

integer · int64

Id of the nested team relation

Example: 1

object

Parent team, the one who receives the invite

object

Price group applied to the nested team

object

User who requested the invitation

selectedChargePointIds

array | null

Selected charge points nested team has access to

Example: [41,72,93]

note

string | null

Internal note for this nested team

Example: Internal note placeholder

updatedAt

string | null · date-time

Datetime of the update of nested team invite

Example: 2022-07-28T18:11:41Z

invitedAt

string | null · date-time

Datetime nested team was invited

Example: 2022-07-28T18:11:41Z

PATCH/api/v1/nested-teams/{relationId}

curl https://partner-api.monta.com/api/v1/nested-teams/:relationId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "priceGroupId": 1,
  "note": "A note for nested team member",
  "selectedChargePointIds": [
    0
  ]
}'

Example Request Body

{
  "priceGroupId": 1,
  "note": "A note for nested team member",
  "selectedChargePointIds": [
    0
  ]
}

json

Example Responses

{
  "id": 1,
  "parentTeam": {
    "id": 1,
    "publicName": "Example Team",
    "memberCount": 10
  },
  "nestedTeam": {
    "id": 1,
    "publicName": "Example Team",
    "memberCount": 10
  },
  "priceGroup": {
    "id": 1,
    "name": "Standard Pricing"
  },
  "invitedByUser": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "displayName": "johndoe123"
  },
  "userRole": "user",
  "access": "all",
  "state": "accepted",
  "selectedChargePointIds": [
    41,
    72,
    93
  ],
  "note": "Internal note placeholder",
  "createdAt": "2022-07-27T18:11:41Z",
  "updatedAt": "2022-07-28T18:11:41Z",
  "invitedAt": "2022-07-28T18:11:41Z"
}

json

application/json

Delete a nested team relation

DELETE

https://partner-api.monta.com

/api/v1/nested-teams/{relationId}

Required scope: team-members:delete
Organization authorization: supported

Delete a nested team relation › path Parameters

relationId

integer · int64 · required

Delete a nested team relation › Responses

Nested team relation deleted

No data returned

Accept a nested team invitation

POST

https://partner-api.monta.com

/api/v1/nested-teams/{relationId}/accept-invite

Required scope: team-members:write
Organization authorization: supported

Accept a nested team invitation › path Parameters

relationId

integer · int64 · required

Accept a nested team invitation › Responses

Nested team relation

NestedTeam

object · required

Parent team, the one who sends the invite

userRole

string · enum · required

The role assigned to the nested team

Enum values:

user

Example: user

access

string · enum · required

Access to parent team CPs / sites: to all or selected charge points and/or sites

Enum values:

all

selected

Example: all

state

string · enum · required

State of the nested team invitation

Enum values:

requested

invited

accepted

rejected_at

blocked

expired

Example: accepted

createdAt

string · date-time · required

Datetime of the creation of nested team invite

Example: 2022-07-27T18:11:41Z

id

integer · int64

Id of the nested team relation

Example: 1

object

Parent team, the one who receives the invite

object

Price group applied to the nested team

object

User who requested the invitation

selectedChargePointIds

array | null

Selected charge points nested team has access to

Example: [41,72,93]

note

string | null

Internal note for this nested team

Example: Internal note placeholder

updatedAt

string | null · date-time

Datetime of the update of nested team invite

Example: 2022-07-28T18:11:41Z

invitedAt

string | null · date-time

Datetime nested team was invited

Example: 2022-07-28T18:11:41Z

POST/api/v1/nested-teams/{relationId}/accept-invite

curl https://partner-api.monta.com/api/v1/nested-teams/:relationId/accept-invite \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": 1,
  "parentTeam": {
    "id": 1,
    "publicName": "Example Team",
    "memberCount": 10
  },
  "nestedTeam": {
    "id": 1,
    "publicName": "Example Team",
    "memberCount": 10
  },
  "priceGroup": {
    "id": 1,
    "name": "Standard Pricing"
  },
  "invitedByUser": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "displayName": "johndoe123"
  },
  "userRole": "user",
  "access": "all",
  "state": "accepted",
  "selectedChargePointIds": [
    41,
    72,
    93
  ],
  "note": "Internal note placeholder",
  "createdAt": "2022-07-27T18:11:41Z",
  "updatedAt": "2022-07-28T18:11:41Z",
  "invitedAt": "2022-07-28T18:11:41Z"
}

json

application/json

Reject a nested team invitation

POST

https://partner-api.monta.com

/api/v1/nested-teams/{relationId}/reject-invite

Required scope: team-members:write
Organization authorization: supported

Reject a nested team invitation › path Parameters

relationId

integer · int64 · required

Reject a nested team invitation › Responses

Nested team relation

NestedTeam

object · required

Parent team, the one who sends the invite

userRole

string · enum · required

The role assigned to the nested team

Enum values:

user

Example: user

access

string · enum · required

Access to parent team CPs / sites: to all or selected charge points and/or sites

Enum values:

all

selected

Example: all

state

string · enum · required

State of the nested team invitation

Enum values:

requested

invited

accepted

rejected_at

blocked

expired

Example: accepted

createdAt

string · date-time · required

Datetime of the creation of nested team invite

Example: 2022-07-27T18:11:41Z

id

integer · int64

Id of the nested team relation

Example: 1

object

Parent team, the one who receives the invite

object

Price group applied to the nested team

object

User who requested the invitation

selectedChargePointIds

array | null

Selected charge points nested team has access to

Example: [41,72,93]

note

string | null

Internal note for this nested team

Example: Internal note placeholder

updatedAt

string | null · date-time

Datetime of the update of nested team invite

Example: 2022-07-28T18:11:41Z

invitedAt

string | null · date-time

Datetime nested team was invited

Example: 2022-07-28T18:11:41Z

POST/api/v1/nested-teams/{relationId}/reject-invite

curl https://partner-api.monta.com/api/v1/nested-teams/:relationId/reject-invite \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": 1,
  "parentTeam": {
    "id": 1,
    "publicName": "Example Team",
    "memberCount": 10
  },
  "nestedTeam": {
    "id": 1,
    "publicName": "Example Team",
    "memberCount": 10
  },
  "priceGroup": {
    "id": 1,
    "name": "Standard Pricing"
  },
  "invitedByUser": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "displayName": "johndoe123"
  },
  "userRole": "user",
  "access": "all",
  "state": "accepted",
  "selectedChargePointIds": [
    41,
    72,
    93
  ],
  "note": "Internal note placeholder",
  "createdAt": "2022-07-27T18:11:41Z",
  "updatedAt": "2022-07-28T18:11:41Z",
  "invitedAt": "2022-07-28T18:11:41Z"
}

json

application/json

Messages Onboarding Profiles