# Entitlements API

{% hint style="warning" %}
Always use the ![](https://3868048845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRJrT3ZeHQnYGnLALMybb%2Fuploads%2Fgit-blob-5e19c5997155d481f1b77468c881d6928be37d95%2FAPI_copy_example.png?alt=media) **Copy** icon in the example field when copying examples. Manual copy and paste is known to cause data format errors.
{% endhint %}

### List entitlements

{% openapi src="<https://3868048845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRJrT3ZeHQnYGnLALMybb%2Fuploads%2Fgit-blob-fd1715e8ea853c83a846ccd6a31780692bc6a148%2Fapi.yaml?alt=media>" path="/api/v2/customer/entitlements" method="get" %}
[api.yaml](https://3868048845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRJrT3ZeHQnYGnLALMybb%2Fuploads%2Fgit-blob-fd1715e8ea853c83a846ccd6a31780692bc6a148%2Fapi.yaml?alt=media)
{% endopenapi %}

### Add entitlement

{% openapi src="<https://3868048845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRJrT3ZeHQnYGnLALMybb%2Fuploads%2Fgit-blob-fd1715e8ea853c83a846ccd6a31780692bc6a148%2Fapi.yaml?alt=media>" path="/api/v2/customer/entitlements" method="post" %}
[api.yaml](https://3868048845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRJrT3ZeHQnYGnLALMybb%2Fuploads%2Fgit-blob-fd1715e8ea853c83a846ccd6a31780692bc6a148%2Fapi.yaml?alt=media)
{% endopenapi %}

### List entitled advisors

{% openapi src="<https://3868048845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRJrT3ZeHQnYGnLALMybb%2Fuploads%2Fgit-blob-fd1715e8ea853c83a846ccd6a31780692bc6a148%2Fapi.yaml?alt=media>" path="/api/v1/customer/entitlements/externalNetwork/{externalNetwork}/advisors" method="get" %}
[api.yaml](https://3868048845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRJrT3ZeHQnYGnLALMybb%2Fuploads%2Fgit-blob-fd1715e8ea853c83a846ccd6a31780692bc6a148%2Fapi.yaml?alt=media)
{% endopenapi %}

### Get an advisor's entitlement

{% openapi src="<https://3868048845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRJrT3ZeHQnYGnLALMybb%2Fuploads%2Fgit-blob-fd1715e8ea853c83a846ccd6a31780692bc6a148%2Fapi.yaml?alt=media>" path="/api/v2/customer/advisor/entitlements" method="get" %}
[api.yaml](https://3868048845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRJrT3ZeHQnYGnLALMybb%2Fuploads%2Fgit-blob-fd1715e8ea853c83a846ccd6a31780692bc6a148%2Fapi.yaml?alt=media)
{% endopenapi %}

### Remove entitlement

{% openapi src="<https://3868048845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRJrT3ZeHQnYGnLALMybb%2Fuploads%2Fgit-blob-fd1715e8ea853c83a846ccd6a31780692bc6a148%2Fapi.yaml?alt=media>" path="/api/v2/customer/advisor/entitlements" method="delete" %}
[api.yaml](https://3868048845-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRJrT3ZeHQnYGnLALMybb%2Fuploads%2Fgit-blob-fd1715e8ea853c83a846ccd6a31780692bc6a148%2Fapi.yaml?alt=media)
{% endopenapi %}