Get Pickup Number Agent
<h2>Overview</h2>
<p>This endpoint is used to fetch details about a specific pickup number agent based on their ID. Replace <code>{pickupNumberAgentId}</code> in the URI with the actual ID of the pickup number agent you want to retrieve information about.</p>
<h2>Request</h2>
<ul>
<li>Method: <strong>GET</strong></li>
<li>URI: <code>/pickupNumberAgents/{pickupNumberAgentId}</code></li>
</ul>
<h2>Code Example</h2>
<pre><code>Request:
curl --location 'https://api.drayeasy.com/api/v2/pickupNumberAgents/10' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxxxxxx'
Response:
HTTP/1.1 201 OK
Content-Type: application/json; charset=utf-8
{
&quot;data&quot;: {
&quot;id&quot;: 10,
&quot;name&quot;: &quot;test update pu agent&quot;,
&quot;emails&quot;: [
&quot;pu1@agent.com&quot;,
&quot;pu2@agent.com&quot;
],
&quot;user_id&quot;: 1,
&quot;user&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;Name1&quot;,
&quot;company&quot;: {
&quot;id&quot;: 1,
&quot;name&quot;: &quot;Company1&quot;
}
}
}
}</code></pre>
<h2>Response Fields Description</h2>
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>Integer</td>
<td>The unique identifier for the pickup agent.</td>
</tr>
<tr>
<td>name</td>
<td>String</td>
<td>The name of the pickup number agent.</td>
</tr>
<tr>
<td>emails</td>
<td>Array</td>
<td>An array of email addresses associated with the pickup agent.</td>
</tr>
<tr>
<td>user_id</td>
<td>Integer</td>
<td>The user ID associated with the pickup agent.</td>
</tr>
<tr>
<td>user</td>
<td>Object</td>
<td>Information about the user associated with the pickup agent, including their ID, name, and company details.</td>
</tr>
<tr>
<td>user.id</td>
<td>Integer</td>
<td>The user's unique identifier.</td>
</tr>
<tr>
<td>user.name</td>
<td>String</td>
<td>The user's name.</td>
</tr>
<tr>
<td>user.company</td>
<td>Object</td>
<td>Information about the company associated with the user, including its ID and name.</td>
</tr>
<tr>
<td>user.company.id</td>
<td>Integer</td>
<td>The company's unique identifier.</td>
</tr>
<tr>
<td>user.company.name</td>
<td>String</td>
<td>The name of the company.</td>
</tr>
</tbody>
</table>
<h2>User Object</h2>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td>The name of the user.</td>
</tr>
<tr>
<td>email</td>
<td>The email address of the user.</td>
</tr>
<tr>
<td>company</td>
<td>The company associated with the user.</td>
</tr>
</tbody>
</table>