# Preferred Authors

## List preferred authors

By default, you can only list preferred authors which have been whitelisted or blacklisted. Preferred authors who completed a document of yours but you didn't rate can be found within the `uncategorized` list.

{% hint style="info" %}
**OAuth:** This endpoint requires one of the following scopes: `preferred_author:manage`, `preferred_author:read` or `preferred_author:write`.
{% endhint %}

{% openapi src="<https://app.textmaster.com/api-docs/v1/clients/specs.yaml>" path="/v1/clients/my\_authors" method="get" %}
<https://app.textmaster.com/api-docs/v1/clients/specs.yaml>
{% endopenapi %}

#### Code samples

```shell
curl -G "https://api.textmaster.com/v1/clients/my_authors" \
  -H "Authorization: Bearer 790d0c6d24747b818f1c83184a2720e603db74b0b7de246365636765569c5d4e"
```

### Add a preferred author

{% hint style="info" %}
**OAuth:** This endpoint requires one of the following scopes: `preferred_author:manage` or `referred_author:write`.
{% endhint %}

{% openapi src="<https://app.textmaster.com/api-docs/v1/clients/specs.yaml>" path="/v1/clients/my\_authors" method="post" %}
<https://app.textmaster.com/api-docs/v1/clients/specs.yaml>
{% endopenapi %}

#### Code samples

```shell
curl "https://api.textmaster.com/v1/clients/my_authors" \
  -X POST \
  -d '{
    "my_author": {
      "description": "Some description",
      "status": "my_textmaster",
      "author_id": "61698aaf8b81926d91c0e889"
    }
  }' \
  -H "Authorization: Bearer 3a7dce3b773247c159b8f18be707c2c5838d2e7138d36813e74e28e43caa0aaa" \
  -H "Content-Type: application/json"
```

## Get a preferred author

{% hint style="info" %}
**OAuth:** This endpoint requires one of the following scopes: `preferred_author:manage`, `preferred_author:read` or `referred_author:write`.
{% endhint %}

{% openapi src="<https://app.textmaster.com/api-docs/v1/clients/specs.yaml>" path="/v1/clients/my\_authors/{author\_id}" method="get" %}
<https://app.textmaster.com/api-docs/v1/clients/specs.yaml>
{% endopenapi %}

#### Code samples

```shell
curl -G "https://api.textmaster.com/v1/clients/my_authors/61698ab08b81926d91c0e8a3" \
  -H "Authorization: Bearer f2a5e17102ca9e6c8494b323847b784615ab1da0f1525258d85af89385fef5f5"
```

## Update a preferred author

{% hint style="info" %}
**OAuth:** This endpoint requires one of the following scopes: `preferred_author:manage` or `referred_author:write`.
{% endhint %}

{% openapi src="<https://app.textmaster.com/api-docs/v1/clients/specs.yaml>" path="/v1/clients/my\_authors/{author\_id}" method="put" %}
<https://app.textmaster.com/api-docs/v1/clients/specs.yaml>
{% endopenapi %}

#### Code samples

```shell
curl "https://api.textmaster.com/v1/clients/my_authors/61698ab08b81926d91c0e8bd" \
  -X PUT \
  -d '{ "my_author": { "description": "Some new description" } }' \
  -H "Authorization: Bearer b9ad70843ca9d09f59bc27f87c1aab02de0dfd03109ca1a7a3f70f899f6427c6" \
  -H "Content-Type: application/json"
```

## List preferred authors able to work on project

{% hint style="info" %}
**OAuth:** This endpoint requires one of the following scopes: `preferred_author:manage`, `preferred_author:read` or `referred_author:write`.
{% endhint %}

{% openapi src="<https://app.textmaster.com/api-docs/v1/clients/specs.yaml>" path="/v1/clients/projects/{project\_id}/my\_authors" method="get" %}
<https://app.textmaster.com/api-docs/v1/clients/specs.yaml>
{% endopenapi %}

#### Code samples

```shell
curl -G "https://api.textmaster.com/v1/clients/projects/61698ab18b81926d91c0e8e7/my_authors" \
  -H "Authorization: Bearer 2a1e347c6aaf1515cbb7e146601e93832359d4edc437e0d494ed195facccc05d"
```